/**
 * <copyright>
 * </copyright>
 *
 * $Id$
 */
package com.lifesting.wfs.Runtime;

import com.lifesting.wfs.gd.Node;
import com.lifesting.wfs.gd.Transition;
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.ecore.EObject;

/**
 * <!-- begin-user-doc -->
 * A representation of the model object '<em><b>Token</b></em>'.
 * <!-- end-user-doc -->
 *
 * <p>
 * The following features are supported:
 * <ul>
 *   <li>{@link com.lifesting.wfs.Runtime.Token#getProcessInstance <em>Process Instance</em>}</li>
 *   <li>{@link com.lifesting.wfs.Runtime.Token#getChildren <em>Children</em>}</li>
 *   <li>{@link com.lifesting.wfs.Runtime.Token#getParent <em>Parent</em>}</li>
 *   <li>{@link com.lifesting.wfs.Runtime.Token#getExecutor <em>Executor</em>}</li>
 *   <li>{@link com.lifesting.wfs.Runtime.Token#getContext <em>Context</em>}</li>
 * </ul>
 * </p>
 *
 * @see com.lifesting.wfs.Runtime.RuntimePackage#getToken()
 * @model
 * @generated
 */
public interface Token extends EObject {

	/**
	 * Returns the value of the '<em><b>Process Instance</b></em>' container reference.
	 * It is bidirectional and its opposite is '{@link com.lifesting.wfs.Runtime.ProcessInstance#getRootToken <em>Root Token</em>}'.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Process Instance</em>' container reference isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Process Instance</em>' container reference.
	 * @see #setProcessInstance(ProcessInstance)
	 * @see com.lifesting.wfs.Runtime.RuntimePackage#getToken_ProcessInstance()
	 * @see com.lifesting.wfs.Runtime.ProcessInstance#getRootToken
	 * @model opposite="rootToken" transient="false"
	 * @generated
	 */
	ProcessInstance getProcessInstance();

	/**
	 * Sets the value of the '{@link com.lifesting.wfs.Runtime.Token#getProcessInstance <em>Process Instance</em>}' container reference.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Process Instance</em>' container reference.
	 * @see #getProcessInstance()
	 * @generated
	 */
	void setProcessInstance(ProcessInstance value);

	/**
	 * Returns the value of the '<em><b>Children</b></em>' containment reference list.
	 * The list contents are of type {@link com.lifesting.wfs.Runtime.Token}.
	 * It is bidirectional and its opposite is '{@link com.lifesting.wfs.Runtime.Token#getParent <em>Parent</em>}'.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Children</em>' containment reference list isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Children</em>' containment reference list.
	 * @see com.lifesting.wfs.Runtime.RuntimePackage#getToken_Children()
	 * @see com.lifesting.wfs.Runtime.Token#getParent
	 * @model opposite="parent" containment="true"
	 * @generated
	 */
	EList<Token> getChildren();

	/**
	 * Returns the value of the '<em><b>Parent</b></em>' container reference.
	 * It is bidirectional and its opposite is '{@link com.lifesting.wfs.Runtime.Token#getChildren <em>Children</em>}'.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Parent</em>' container reference isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Parent</em>' container reference.
	 * @see #setParent(Token)
	 * @see com.lifesting.wfs.Runtime.RuntimePackage#getToken_Parent()
	 * @see com.lifesting.wfs.Runtime.Token#getChildren
	 * @model opposite="children" transient="false"
	 * @generated
	 */
	Token getParent();

	/**
	 * Sets the value of the '{@link com.lifesting.wfs.Runtime.Token#getParent <em>Parent</em>}' container reference.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Parent</em>' container reference.
	 * @see #getParent()
	 * @generated
	 */
	void setParent(Token value);

	/**
	 * Returns the value of the '<em><b>Executor</b></em>' reference.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Executor</em>' reference isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Executor</em>' reference.
	 * @see #setExecutor(NodeExecutor)
	 * @see com.lifesting.wfs.Runtime.RuntimePackage#getToken_Executor()
	 * @model
	 * @generated
	 */
	NodeExecutor getExecutor();

	/**
	 * Sets the value of the '{@link com.lifesting.wfs.Runtime.Token#getExecutor <em>Executor</em>}' reference.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Executor</em>' reference.
	 * @see #getExecutor()
	 * @generated
	 */
	void setExecutor(NodeExecutor value);

	/**
	 * Returns the value of the '<em><b>Context</b></em>' containment reference.
	 * It is bidirectional and its opposite is '{@link com.lifesting.wfs.Runtime.Context#getToken <em>Token</em>}'.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Context</em>' containment reference isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Context</em>' containment reference.
	 * @see #setContext(Context)
	 * @see com.lifesting.wfs.Runtime.RuntimePackage#getToken_Context()
	 * @see com.lifesting.wfs.Runtime.Context#getToken
	 * @model opposite="token" containment="true"
	 * @generated
	 */
	Context getContext();

	/**
	 * Sets the value of the '{@link com.lifesting.wfs.Runtime.Token#getContext <em>Context</em>}' containment reference.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Context</em>' containment reference.
	 * @see #getContext()
	 * @generated
	 */
	void setContext(Context value);

	/**
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
	void signal(String transition);

	/**
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
	void signal();

	/**
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
	Transition getTransitionByName(String transitionName);

	/**
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @model kind="operation"
	 * @generated
	 */
	Transition getDefaultTransition();

	/**
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
	void signal(Transition transition);

	/**
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
	Token createChild();
} // Token
